home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 076-100 / scopedisk83 / qmouse15 / qmouse.doc < prev    next >
Text File  |  1995-03-19  |  24KB  |  727 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                        QMouse 1.5 Copyright 1989 by Lyman Epp
  8.  
  9.           Another "Mouse  Accelerator???"  What for?  It seems that all the
  10.           other mouse accelerators have been written in "C".  This is okay,
  11.           but the  programs are  10-30K.  This mouse accelerator is written
  12.           in assembler and contains most of the features of the others, but
  13.           the program size is less than 4K bytes!  QMouse stands for "Quick
  14.           Mouse."
  15.  
  16.           This is being distributed as ShareWare.  If you think that QMouse
  17.           is  useful,  please  send  $10.    Your  response will insure the
  18.           release of more quality programs for  your  Amiga!    Be  sure to
  19.           check out the latest shareware version of QView.
  20.  
  21.           The latest  version of  QMouse can  always be  found first on the
  22.           Wind Dragon Inn  BBS,  (402)-291-8053  or  Larry's  Hot  Tub BBS,
  23.           (402)-571-4316.
  24.  
  25.  
  26.                                     Lyman R. Epp
  27.                                 10072 Wirt Plaza #15
  28.                                 Omaha, Nebraska 68134
  29.  
  30.  
  31.  
  32.  
  33.  
  34.                           THANKS TO THESE REGISTERED USERS!
  35.  
  36.                     D. J. James                   Ted Michelse
  37.                     Scott Brickner                Paul O'Keefe
  38.                     Elliott Hammett               Robert Gregory
  39.                     David Cole                    Jeremy Farrance
  40.                     Ken Rahmoeller                Bill Hogsett
  41.                     Eric Schwertfeger             John Robertson
  42.                     Peter Sawko                   Richard Lindzen
  43.                     Michael Cowperthwaite         W. Carl Day
  44.                     Richard Glanzer               Mark Kenne
  45.                     Kurt Wessels                  Donald Clark
  46.                     Frank De Francesco            Michael Sawyer
  47.                     Jack R. Smith                 Bryan Pinette
  48.                     James Zulliger                Ed Vishoot
  49.                     Keith Burton                  Vince Marco
  50.                     Scott Michael                 David Shriver
  51.                     Rich Falconburg
  52.  
  53.  
  54.  
  55.                             THANKS TO THESE BETA TESTERS!
  56.  
  57.                     Clete Baker                   Vince Marco
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                           1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.                                    QMOUSE FEATURES
  74.  
  75.  
  76.           o    Screen  blanks  if  keyboard  or  mouse is idle for a while.
  77.                This will prevent an image "burning" onto your monitor while
  78.                left unattended.
  79.  
  80.           o    The mouse  pointer blanks if mouse is idle for a while.  The
  81.                mouse pointer will also  blank when  the first  keystroke is
  82.                typed.
  83.  
  84.           o    Mouse accelerator  with configurable  threshold to allow for
  85.                precise mouse pointer positioning.
  86.  
  87.           o    Automatic window activation (i.e.  Sun  Mouse).    Makes the
  88.                window under the mouse pointer the active window.  Sun Mouse
  89.                will  not  activate  windows  if  either   mouse  button  is
  90.                depressed--this  will  allow  you  to  move  WorkBench icons
  91.                between windows.
  92.  
  93.           o    Multiple configurable hot keys,  ala PopCli,  activated with
  94.                the <Left Amiga><hotkey> combination.  The <Left Amiga><Esc>
  95.                combination is preset to  execute NEWCLI.   The  RUN command
  96.                must be in your C: directory.
  97.  
  98.           o    Keyboard  record/playback.    <Left  Alt><Esc>  toggles  the
  99.                keystroke recorder on and off.  Press <Left  Alt><Return> to
  100.                playback the previously recorded keystrokes.
  101.  
  102.           o    Window to  front.  Left Mouse Button click(s) in window will
  103.                bring it to the front.  Won't try to bring the window to the
  104.                front if  it is  already in the front.  The number of clicks
  105.                required  is  configurable.    The  time  between  clicks is
  106.                determined by Preferences.
  107.  
  108.           o    Window to back.  Hold down the Left Mouse Button in a window
  109.                and click the Right Mouse Button to send that window  to the
  110.                back.
  111.  
  112.           o    Screen  shuffle.    Press  <Left Amiga><M> to send the front
  113.                screen to the back.  The screen that comes to the front will
  114.                have its previously active window made active.
  115.  
  116.           o    The smallest clock yet!  Can be turned off if you don't like
  117.                clocks.  The amount  of available  memory can  optionally be
  118.                displayed.  Starting column is also configurable.  The clock
  119.                window will  be  brought  to  the  front  (of  the WorkBench
  120.                screen) whenever it becomes obscured.
  121.  
  122.           o    Every option  can be turned off or modified.  Options can be
  123.                entered from the  command  line  (e.g.  Startup-Sequence) or
  124.                from a user specifiable configuration file.
  125.  
  126.  
  127.  
  128.  
  129.                                           2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.           o    Uses  a  background  CLI.   Programs like DMouse and PopCLI3
  140.                don't use  a  background  CLI,  and  therefore  any NewCLI's
  141.                spawned by  them will  have no default directory, no default
  142.                path, etc.  You can now set the  stack size  for any spawned
  143.                CLI's.  This will allow you to set a lower stack size before
  144.                starting QMouse,  but  insure  an  adequate  stack  size for
  145.                spawned CLI's.
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                           3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.                                COMMAND LINE ARGUMENTS
  206.  
  207.  
  208.           Arguments can  be typed in upper or lower case.  Arguments can be
  209.           enclosed in quotes, e.g.  "-A3".    Quotes  are  required  if the
  210.           argument contains  spaces, otherwise they are optional.  Commands
  211.           can also be in a configuration file and used with the -F option.
  212.  
  213.  
  214.           -A#            Set acceleration to #.  Can be in  the range  of 0
  215.                          to 65,535.  Mouse movement events that have X or Y
  216.                          motion  greater  than  the  acceleration threshold
  217.                          (see  option  -T)  will  be  accelerated  by  this
  218.                          factor.  The default acceleration value is 3.   To
  219.                          disable this feature, specify 0 or 1.
  220.  
  221.  
  222.           -B             Enable click to back feature.
  223.  
  224.  
  225.           -C[E][M][#]    Activate  clock.    To  display  clock  in 24 hour
  226.                          format (European), specify an  "E" after  the "C".
  227.                          To display  available memory, specify an "M" after
  228.                          the "C" (e.g. -CM).  If both "E" and "M" are used,
  229.                          the "E"  must come  before the  "M".  You can also
  230.                          specify an optional column where the clock will be
  231.                          displayed.   The width  of the  clock is 44 pixels
  232.                          (92 if available memory is displayed.)  The column
  233.                          number must  be in the range of 0 to [screen width
  234.                          - clock width].   To place  the clock  next to the
  235.                          front/back gadgets, use a value of [screen width -
  236.                          clock width - 53].  With a screen width of 640 and
  237.                          with available  memory displayed,  this would be a
  238.                          column value of 495 (-CM495).   The default column
  239.                          value is 280.
  240.  
  241.  
  242.           -Ecommand      Set command  to execute  when <Left Amiga><Esc> is
  243.                          pressed.  If the command contains spaces, then the
  244.                          entire command  must be  enclosed in  quotes.  The
  245.                          default command is NEWCLI.   The  RUN command must
  246.                          be  in  your  C:  directory.  The RUN command MUST
  247.                          precede  any  commands  other  than  NEWCLI  (e.g.
  248.                          "-eRun ed".)
  249.  
  250.  
  251.           -Fname         Read configuration  information from the specified
  252.                          file.  The -F option can  be nested  any number of
  253.                          levels (or until the stack overflows.)  The format
  254.                          for the configuration  file  is  identical  to the
  255.                          command line  format.   Each option can be entered
  256.                          on a separate  line.    Anything  between  a semi-
  257.                          colon character  ";" and  the end of the line will
  258.                          be considered a comment.   A  sample configuration
  259.                          file is included.
  260.  
  261.                                           4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.           -Hxx=command   Set the  command to  execute when  this hot key is
  272.                          invoked.  The 'xx'  parameter defines  the raw key
  273.                          code  for  this  hot  key.    Whenever this key is
  274.                          pressed in combination with the <Left Amiga><key>,
  275.                          the command  will be executed.  The raw key values
  276.                          are printed later in this documentation.  For more
  277.                          information, see option -E.
  278.  
  279.  
  280.           -K#            Set number of clicks required to bring a window to
  281.                          the front.   The  default value  is 2  clicks.  To
  282.                          disable this feature, specify 0 clicks.  Can be in
  283.                          the range of 0 to 65,535 clicks.
  284.  
  285.  
  286.           -M             Deactivate the screen shuffler.  The  <Left Amiga>
  287.                          <M> combination  will revert  to Intuition pushing
  288.                          the WorkBench screen to  the back.   To deactivate
  289.                          the screen shuffler completely, specify -M.
  290.  
  291.  
  292.           -P#            Set the  number of  seconds to  wait after a mouse
  293.                          event before blanking  the  mouse  pointer.   Just
  294.                          move  the   mouse  again   and  the  pointer  will
  295.                          reappear.  The default  value is  10 seconds.   To
  296.                          disable this  feature, specify  0 seconds.  Can be
  297.                          in the range of 0 to 65,535 seconds.
  298.  
  299.  
  300.           -R             Enable automatic window activation.
  301.  
  302.  
  303.           -S#            Set the number of seconds to  wait after  any user
  304.                          event  (keyboard,  mouse  or  disk changed) before
  305.                          blanking the screen.  Just move the mouse,  type a
  306.                          key  or  insert  a  disk  and  the  screen will be
  307.                          restored.  The default value is  600 seconds.   To
  308.                          disable this  feature, specify  0 seconds.  Can be
  309.                          in the range of 0 to 65,535 seconds.
  310.  
  311.  
  312.           -T#            Set mouse  acceleration  threshold  in  pixels per
  313.                          event (see option -A).  This option provides a way
  314.                          to position  the mouse  pointer precisely, without
  315.                          the acceleration factor "getting in the way."  The
  316.                          default value is 3.  Can be in  the range  of 0 to
  317.                          65,535 pixels per event.
  318.  
  319.  
  320.           -V#            Set the  stack size  for any  spawned CLI's.  This
  321.                          allows the stack size for the  QMouse's CLI  to be
  322.                          set to  a minimum.   The default value is obtained
  323.                          from the CLI that QMouse was run from.  Can  be in
  324.                          the range of 1800 to 655,360 bytes.
  325.  
  326.  
  327.                                           5
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.                                      HOW TO USE
  338.  
  339.  
  340.           QMouse must  be executed from a CLI (or from a Startup-Sequence.)
  341.           It can't be run from WorkBench.  It  is recommended  that you set
  342.           the  stack  size  to  2000  before  starting  QMouse.  It is also
  343.           recommended that you use the -V option of QMouse to set the stack
  344.           size for any spawned CLI's to at least 20000.
  345.  
  346.                1> STACK 2000
  347.                1> RUN >NIL: QMouse -B -CEM543 -R -V20000 -FS:QMouse.cfg
  348.                1> STACK 20000
  349.  
  350.  
  351.  
  352.                                   TO REMOVE QMOUSE
  353.  
  354.  
  355.           Press <Control><Left Amiga><Esc> (all at the same time.)
  356.  
  357.  
  358.  
  359.                                      SOURCE CODE
  360.  
  361.  
  362.           Due to  the large  size of the source code for QMouse (over 50K),
  363.           it will no longer be distributed.  If you desire the source code,
  364.           please send an SASE and a disk with your QMouse donation.  Please
  365.           feel free to send the disk with public domain programs.
  366.  
  367.  
  368.  
  369.                                        CREDITS
  370.  
  371.  
  372.           This program has been inspired  by  PopCLI,  MachII,  DMouse, and
  373.           others.   Thanks to  the authors  of these programs for providing
  374.           good examples of how to make the Amiga "do its thing!"
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                           6
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.                                  RAW KEY DEFINITIONS
  404.  
  405.  
  406.                   Raw Key                       Raw Key
  407.                   Number      Key               Number      Key
  408.  
  409.                     00        `                   30        Undefined
  410.                     01        1                   31        Z
  411.                     02        2                   32        X
  412.                     03        3                   33        C
  413.                     04        4                   34        V
  414.                     05        5                   35        B
  415.                     06        6                   36        N
  416.                     07        7                   37        M
  417.                     08        8                   38        <
  418.                     09        9                   39        >
  419.                     0A        0                   3A        /
  420.                     0B        -                   3B        Undefined
  421.                     0C        =                   3C        NK.
  422.                     0D        \                   3D        NK7
  423.                     0E        Undefined           3E        NK8
  424.                     0F        NK0                 3F        NK9
  425.                     10        Q                   40        Space
  426.                     11        W                   41        Back Space
  427.                     12        E                   42        Tab
  428.                     13        R                   43        Enter
  429.                     14        T                   44        Return
  430.                     15        Y                   45        Escape
  431.                     16        U                   46        Del
  432.                     17        I                   47        Undefined
  433.                     18        O                   48        Undefined
  434.                     19        P                   49        Undefined
  435.                     1A        {                   4A        NK-
  436.                     1B        }                   4B        Undefined
  437.                     1C        Undefined           4C        UP
  438.                     1D        NK1                 4D        DOWN
  439.                     1E        NK2                 4E        RIGHT
  440.                     1F        NK3                 4F        LEFT
  441.                     20        A                   50        F1
  442.                     21        S                   51        F2
  443.                     22        D                   52        F3
  444.                     23        F                   53        F4
  445.                     24        G                   54        F5
  446.                     25        H                   55        F6
  447.                     26        J                   56        F7
  448.                     27        K                   57        F8
  449.                     28        L                   58        F9
  450.                     29        ;                   59        F10
  451.                     2A        "                   5A        Undefined
  452.                     2B        Undefined           5B        Undefined
  453.                     2C        Undefined           5C        Undefined
  454.                     2D        NK4                 5D        Undefined
  455.                     2E        NK5                 5E        Undefined
  456.                     2F        NK6                 5F        Help
  457.  
  458.  
  459.                                           7
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.                                   RELEASE 1.1 NOTES
  470.                                      08-Jul-1988
  471.  
  472.  
  473.           o    Made the clock come to the front whenever its been obscured,
  474.                rather  than  every  10  seconds.    This was bothering some
  475.                programs.  Thanks to D. J. James for this idea.
  476.  
  477.           o    The manual incorrectly documented  the <Control><Left Amiga>
  478.                <Esc> method  of terminating  QMouse.  This should have read
  479.                <Control><Left Amiga><F1>, but I changed the program to work
  480.                as documented.
  481.  
  482.           o    Intuition will  restore the  mouse pointer  occasionally.  I
  483.                changed QMouse  to re-blank  the mouse  pointer quicker than
  484.                before.
  485.  
  486.  
  487.  
  488.                                   RELEASE 1.2 NOTES
  489.                                      30-Aug-1988
  490.  
  491.  
  492.           o    Modified  to  assemble  with  the  Manx assembler.  The Manx
  493.                assembler  creates  about  5-10%  smaller  code.    See  the
  494.                included  makefile  for  assembling with the Manx assembler.
  495.                Source will still assemble  with the  Metacomco assembler as
  496.                before!
  497.  
  498.           o    Intuition calls  are now  made from  the QMouse task, rather
  499.                than from  the  input  handler.    This  should  resolve any
  500.                Intuition lockups.
  501.  
  502.           o    WindowToFront() not  called for BACKDROP type windows.  This
  503.                should help eliminate the  possibility of  WorkBench locking
  504.                up.
  505.  
  506.           o    Added automatic window activation (i.e. Sun Mouse).  Specify
  507.                option -R to activate Sun Mouse (-S was already used.)
  508.  
  509.           o    Added click to back feature.  Specify option  -B to activate
  510.                click to back.
  511.  
  512.           o    Added  stack  size  feature.    Allows  QMouse to run with a
  513.                smaller stack while insuring adequate stack size for spawned
  514.                CLI's.  Specify option -V to change the default stack size.
  515.  
  516.           o    Fixed bug  with clicking  to front a window on a screen that
  517.                is in the background.  No one had reported this bug yet. ;-)
  518.  
  519.           o    Cleaned up documentation and  fixed any  inaccuracies that I
  520.                found.      Documentation   for   option  -M  now  reads  to
  521.                "deactivate" the screen shuffler.   Actually,  the -M option
  522.                was ignored until release 1.2.
  523.  
  524.  
  525.                                           8
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.                                   RELEASE 1.3 NOTES
  536.                                      6-Oct-1988
  537.  
  538.  
  539.           o    Added multiple hot key support.  Specify option -H to define
  540.                multiple hot key commands.  Thanks  to Clete  Baker for this
  541.                idea.
  542.  
  543.           o    Added  keyboard  record/playback  support.   <Left Alt><Esc>
  544.                toggles  the  recorder  on  and  off.    <Left  Alt><Return>
  545.                activates the keyboard playback.
  546.  
  547.           o    Added ability  to read  commands from  a configuration file.
  548.                This was needed to  support  multiple  hot  key definitions.
  549.                Specify option -F to read commands from a file.
  550.  
  551.           o    Added option  to display the amount of available memory with
  552.                the clock.  Add the "M" modifier to option -C to display the
  553.                amount of available memory (e.g. -CM).
  554.  
  555.           o    Added option  to display  the time  in 24 hour format.  This
  556.                option was added at the request of Jim Cooper.
  557.  
  558.           o    When  pointer  blanking  is  enabled,  the  pointer  will be
  559.                blanked immediately  when a  key is  typed.   Thanks to Eric
  560.                Schwertfeger for this idea.
  561.  
  562.           o    Changed the method of  screen blanking.   Previously, QMouse
  563.                opened  an  Intuition  screen  and  changed it's colors, now
  564.                QMouse turns off DMA  for the  COPPER.   This shaved  off 88
  565.                bytes from QMouse.
  566.  
  567.           o    General code  cleanup.  Tried to make the code more reliable
  568.                in certain situations.  The code  size grew  several hundred
  569.                bytes on account of this effort.
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.                                           9
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.                                   RELEASE 1.4 NOTES
  602.                                      29-Oct-1988
  603.  
  604.  
  605.           o    Restored the  method of screen blanking to version 1.2.  The
  606.                screen blanker in version  1.3 could  sometimes lock  up the
  607.                display.  Thanks to Elliott Hammett for reporting this bug!
  608.  
  609.           o    Changed the  method of pointer blanking.  This takes care of
  610.                the problem of Intuition restoring the pointer occasionally.
  611.                This makes pointer blanking usable with WordPerfect.
  612.  
  613.           o    Changed  the  screen  shuffler to automatically activate the
  614.                new front  screen's  previously  active  window.    This may
  615.                conflict with programs that use the screen's UserData field.
  616.                Thanks to Eric Schwertfeger  and  Jeremy  Farrance  for this
  617.                idea.
  618.  
  619.           o    Made  QMouse  look  like  a  process rather than a CLI.  You
  620.                still need  to use  Run, but  it will  not appear  as a CLI.
  621.                This frees up this CLI for other uses.  Thanks to Jim Cooper
  622.                for this idea.
  623.  
  624.           o    Changed the -F option to  allow  control  characters  in the
  625.                configuration  file.    This  allows the TAB character to be
  626.                treated like a space.  Thanks to Jim Cooper for this idea.
  627.  
  628.           o    Changed the recommended  stack  size  for  QMouse  from 4000
  629.                bytes to 2000 bytes.  It is not recommended to use any value
  630.                less than 2000 bytes.
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.                                          10
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.                                   RELEASE 1.5 NOTES
  668.                                      14-Mar-1989
  669.  
  670.  
  671.           o    Changed the screen shuffler  to  automatically  activate the
  672.                first window on a screen if the previously active window has
  673.                been closed.  Also,  the  screen's  UserData  field  will be
  674.                undisturbed if screen shuffling is disabled.
  675.  
  676.           o    Restored the method of screen blanking to version 1.3.  Some
  677.                minor changes were also made.
  678.  
  679.           o    Changed the method of pointer blanking (again!)  Version 1.4
  680.                conflicted with  Phasar V3.0.  Thanks to Elliott Hammett for
  681.                reporting this bug.
  682.  
  683.           o    Allowed the screen  shuffler  and  playback  keys  to repeat
  684.                normally.
  685.  
  686.           o    Added  memory  management  functions.  This should eliminate
  687.                any memory fragmentation by  QMouse.    All  memory  will be
  688.                allocated in 1K blocks and sub-allocated.
  689.  
  690.           o    Removed code that made QMouse look like a process.  Why look
  691.                like a process when you are really a CLI?
  692.  
  693.           o    Fixed a  bug in  the record/playback  keys.   It would trash
  694.                four  bytes  at  memory  location  $0.    Thanks  to Michael
  695.                Groshart for reporting this bug.
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.                                          11
  724.  
  725.  
  726.  
  727.